ShowTable of Contents
Verifying proper installation and initialization of your TCSPI adapter
See
Installation verification steps in Appendix B of the
Sametime Standard SDK
. It documents the steps for verifying the installation of the SDK reference implementation MyAV; these same steps apply to your adapter. Additionally, you should check the trace.log file of the Media Manager for key messages indicating your TCSPI adapter was recognized, loaded, initialized, and ready to process conference calls. To confirm your TCSPI adapter JAR is recognized, search for this message:
[...] STConferenceManager loadService AVKCS1013I: For Conference Service com.example.YourConferenceService ClassLoader URLs included are
file/.../sametime_tcspi/your_install_dir/
file:/.../sametime_tcspi/your_install_dir/your_adapter.jar
When the Sametime client initializes, it queries the Media Manager for the list of installed adapters and their configuration parameters (ConferenceManager.properties) via the adapter's ConferenceService.getConfiguration method. The corresponding client log for the method com.ibm.collaboration.realtime.telephony.tcspi.TCSPICallServiceProvider
setProviderProperties stores the values returned by the server.
Recommended Sametime client trace options for debugging TCSPI adapter problems
See
Logging and tracing on Lotus Sametime Connect for how-to instructions. For general-problem diagnosis, set these trace options:
com.ibm.collaboration.realtime.internal.telephony.level=FINE
com.ibm.collaboration.realtime.telephony.level=FINE
com.ibm.collaboration.realtime.telephony.tcspi.level=FINER
The Sametime softphone uses SIP messages to communicate and respond to the Media Manager; by enabling the trace option below, an additional log called sip.log will be created:
com.ibm.collaboration.realtime.telephony.softphone.level=FINE
The softphone SIP log contains all the incoming/outgoing messages. The incoming messages are prefixed by three < arrows and the outgoing messages are prefixed by three > arrows. The SIP message methods of particular interest are:
- REGISTER - tells the SIP Proxy/Register how to contact the softphone)
- INVITE - initiates a SIP session and provides acceptable transport and media formats
- ACK - acknowledges a previously negotiated session descriptor
- OK - indicates final agreement with a previously ACK'd session description in a SIP negotiation sequence
When diagnosing problems between the softphone and Media Manager, the sip.log (client) and conference.log (server) entries can be used as an "index" to the much larger trace.xml (client) and trace.log (server) files.
Example of more specific trace options like for the user interface:
com.ibm.collaboration.realtime.telephony.ui.level=FINE
Note: Don't include the "multimedia" flags as recommended in the documentation unless you have GIPS errors,
com.ibm.collaboration.realtime.multimedia.level=FINE
They're unneeded and generate a lot of "noise" entries.
Recommended Media Manager trace options for debugging TCSPI adapter problems
See
Setting a diagnostic trace on a Lotus Sametime Media Manager server for how-to instructions. For general problem diagnosis, set these trace options:
com.lotus.sametime.telephony.*=fine:
com.ibm.mediaserver.*=all:
com.ibm.telephony.conferencing.spi.*=fine:
com.lotus.sametime.telephonymanager.*=fine
For problems related to SIP messages (e.g., failure to register, message delivery failures, authentication failures, timeouts), add these trace options:
com.ibm.ws.sip.*=all:
com.lotus.sametime.telephony.sipfocus.*=all:
com.ibm.sip.*=all:
Note the above options generate a considerable volume of low-level SIP container messages. These are important for diagnosing specific SIP message failures, but unnecessarily voluminous for...
Common Problems and Solutions
Symptom: Cannot make calls, Computer endpoint not shown in dropdown on Contact List, audio/video preferences not shown.
Causes and Solutions: - Policy does not allow for audio/video or third-party audio-video; check Sametime System Console (SSC) policy settings. If set correctly, logs should include AllowP2PVideoChat=true and av.allowAccessToTPartyFromCListAndIM=true log entries.
- Client or server firewalls are blocking SIP registration of client. Confirm SIP ports for secure and unsecure messages are unblocked (typically 5060, 5061).
- Media Server cannot register with the Sametime Community Server because VP port is blocked. Add Media Manager to Sametime trusted IPs in the SSC.
Symptom: Call participants will remain in Connecting status, not Connected
Cause and Solution: TCSPI adapter failed to set user.CONNECTION_PROPERTY in response to third-party MCU bringing participant into call. Check for failed notification from MCU to TCSPI adapter.
Symptom: SIP messages between MCU and Media Manager fail with "503 Service Unavailable"
Cause and Solution: Transport and/or security mismatch between sender and receiver, i.e., attempting to send a secure SIP message to an unsecured port. Check that sender is using TLS / secure ports or UCP and unsecure ports.
Symptom: SIP messages between MCU and Media Manager fail with security certificate error messages.
Cause and Solution: If the third-party opens a TLS connection to the SIP Proxy/Registrar, it must have previously exchanged certificates between the server and/or profiles hosting the Media Manager and third-party SIPlet by exporting the SIP Proxy/Registrar's certificate to the MCU and vice versa.